POST | https://[domain].deskie.io/api/staff.json
{
"staff" : {
"staff_email" : "staff@domain.com",
"staff_full_name" : "Staff full name",
"staff_signature" : "Staff signature"
}
}
{
"staff" : {
"staff_id" : 200,
"staff_email" : "staff@domain.com",
"staff_full_name" : "Staff full name",
"staff_signature" : "Staff signature",
"thumbnail" : "",
"active" : false,
"created_at" : Mon, 05 May 2014 00:15:17 +0300,
"updated_at" : Tue, 23 Dec 2014 10:55:23 +0200
}
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X POST -d '{ "staff": { "staff_email":"staff@domain.com", "staff_full_name":"Staff full name", "staff_signature":"Staff signature" }}' https://[domain].deskie.io/api/staff.json
GET | https://[domain].deskie.io/api/staff.json
{
"0" : {
"staff" : {
"staff_id" : 200,
"staff_email" : "staff@domain.com",
"staff_full_name" : "Staff full name",
"staff_signature" : "Staff signature",
"thumbnail" : "",
"active" : false,
"status" : "online", // deprecated parameter, which is currently used by
// Deskie mobile applications, but will be phased out
// in the future → please refer to status_id
"status_id": 1,
"created_at" : Mon, 05 May 2014 00:15:17 +0300,
"updated_at" : Tue, 23 Dec 2014 10:55:23 +0200
}
},
"1" : {
"staff" : {
"staff_id" : 210,
"staff_email" : "staff2@domain.com",
"staff_full_name" : "Staff 2 full name",
"staff_signature" : "Staff 2 signature",
"thumbnail" : "http://[domain].deskie.io/path/avatar.jpeg",
"active" : true,
"status" : "offline", // deprecated parameter, which is currently used by
// Deskie mobile applications, but will be phased out
// in the future → please refer to status_id
"status_id": 2,
"created_at" : Mon, 05 May 2014 00:15:17 +0300,
"updated_at" : Tue, 23 Dec 2014 10:55:23 +0200
}
},
"total_count":2
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X GET https://[domain].deskie.io/api/staff.json?limit=50&page=2
GET | https://[domain].deskie.io/api/staff_roles.json
{
"0": {
"staff_roles": {
"role_id": 3,
"role": "First-line support"
}
},
"1": {
"staff_roles": {
"role_id": 9,
"role": "Second-line support"
}
},
"2": {
"staff_roles": {
"role_id": 53,
"role": "Top management"
}
},
"count": 3
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X GET https://[domain].deskie.io/api/staff_roles.json
GET | https://[domain].deskie.io/api/staff_statuses.json
{
"0": {
"staff_statuses": {
"status_id": 1,
"status": "Online",
"active": true
}
},
"1": {
"staff_statuses": {
"status_id": 3,
"status": "Without chats",
"active": true
}
},
"2": {
"staff_statuses": {
"status_id": 113,
"status": "Lunch",
"active": false
}
},
"3": {
"staff_statuses": {
"status_id": 120,
"status": "Demo",
"active": false
}
},
"4": {
"staff_statuses": {
"status_id": 2,
"status": "Offline",
"active": true
}
},
"count": 5
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X GET https://[domain].deskie.io/api/staff_statuses.json
GET | https://[domain].deskie.io/api/staff/[id].json
{
"staff" : {
"staff_id" : 200,
"staff_email" : "staff@domain.com",
"staff_full_name" : "Staff full name",
"staff_signature" : "Staff signature",
"thumbnail" : "",
"active" : false,
"status" : "online", // deprecated parameter, which is currently used by
// Deskie mobile applications, but will be phased out
// in the future → please refer to status_id
"status_id": 1,
"created_at" : Mon, 05 May 2014 00:15:17 +0300,
"updated_at" : Tue, 23 Dec 2014 10:55:23 +0200
}
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X GET https://[domain].deskie.io/api/staff/200.json
PUT | https://[domain].deskie.io/api/staff/[id].json
{
"staff" : {
"staff_full_name" : "Staff full name changed"
}
}
{
"staff" : {
"staff_id" : 200,
"staff_email" : "staff@domain.com",
"staff_full_name" : "Staff full name changed",
"staff_signature" : "Staff signature",
"thumbnail" : "",
"active" : false,
"created_at" : Mon, 05 May 2014 00:15:17 +0300,
"updated_at" : Tue, 23 Dec 2014 10:55:23 +0200
}
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X PUT -d '{ "staff": { "staff_full_name":"Staff full name changed" }}' https://[domain].deskie.io/api/staff/200.json
PUT | https://[domain].deskie.io/api/staff/[id]/disable.json
{
"staff" : {
"replace_staff_id" : 300
}
}
{
"staff" : {
"staff_id" : 200,
"staff_email" : "staff@domain.com",
"staff_full_name" : "Staff full name changed",
"staff_signature" : "Staff signature",
"active" : false,
"created_at" : Mon, 05 May 2014 00:15:17 +0300,
"updated_at" : Tue, 23 Dec 2014 10:55:23 +0200
}
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X PUT -d '{ "staff": { "replace_staff_id":"300" }}' https://[domain].deskie.io/api/staff/200/disable.json
PUT | https://[domain].deskie.io/api/staff/[id]/enable.json
{
"staff" : {
"staff_id" : 200,
"staff_email" : "staff@domain.com",
"staff_full_name" : "Staff full name changed",
"staff_signature" : "Staff signature",
"active" : true,
"created_at" : Mon, 05 May 2014 00:15:17 +0300,
"updated_at" : Tue, 23 Dec 2014 10:55:23 +0200
}
}
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X PUT -d '' https://[domain].deskie.io/api/staff/200/enable.json
DELETE | https://[domain].deskie.io/api/staff/[id].json
{
"staff" : {
"replace_staff_id" : 300
}
}
HTTP Status: 200 OK
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X DELETE https://[domain].deskie.io/api/staff/200.json